Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tweak npm scripts #1197

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Tweak npm scripts #1197

wants to merge 1 commit into from

Conversation

XhmikosR
Copy link
Contributor

@XhmikosR XhmikosR commented Mar 4, 2025 •
edited
Loading

Now CI runs build once.

Draft until #1194 is sorted.

Thank you for your contribution to the Pi-hole Community!

Please read the comments below to help us consider your Pull Request.

We are all volunteers and completing the process outlined will help us review your commits quicker.

Please make sure you

  1. Base your code and PRs against the repositories developmental branch.
  2. Sign Off all commits as we enforce the DCO for all contributions
  3. Sign all your commits as they must have verified signatures
  4. File a pull request for any change that requires changes to our documentation at our documentation repo

What does this PR aim to accomplish?:

How does this PR accomplish the above?:

Link documentation PRs if any are needed to support this PR:

By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)
  6. I have checked that another pull request for this purpose does not exist.
  7. I have considered, and confirmed that this submission will be valuable to others.
  8. I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  9. I give this submission freely, and claim no ownership to its content.
  • I have read the above and my PR is ready for review. Check this box to confirm

@netlify Netlify
Copy link

netlify bot commented Mar 4, 2025 •
edited
Loading

✅ Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit d843b5f
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/67cf3f7c3b98030008b9d2fc
😎 Deploy Preview https://deploy-preview-1197--pihole-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@XhmikosR XhmikosR marked this pull request as ready for review March 5, 2025 19:15
@XhmikosR
Copy link
Contributor Author

XhmikosR commented Mar 5, 2025

Can be squashed when merging.

DL6ER
DL6ER reviewed Mar 10, 2025
View reviewed changes
package.json
@@ -16,11 +16,12 @@
},
"homepage": "https://docs.pi-hole.net/",
"scripts": {
"build": "mkdocs build --clean",
"build": "mkdocs build --clean --strict",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for the sake of documentation: --strict determines how warnings are handled. Set to halt processing when a warning is raised. Otherwise, print a warning and continue processing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took this from the CI config https://github.com/pi-hole/docs/blob/master/.github/workflows/ci.yml#L44

package.json
"markdownlint": "markdownlint-cli2 \"**/*.md\" \"!**/node_modules/**\"",
"linkinator": "npm run build && linkinator site --recurse --silent --skip \"^(?!http://localhost)\"",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it still working when we remove the build step here? I'm asking because when we run npm run test locally before committing/pushing, where does it run the necessary build step?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, no. You need to build the docs manually.

Alternatively, we could just change the CI script if you prefer that.

@XhmikosR
Tweak npm scripts
d843b5f 
* add `--strict` in the mkdocs build like on CI
* add a `start` script to run serve (can be used with `npm start`)
* move `build` to `pretest`

As a result, build runs once on CI now
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DL6ER DL6ER DL6ER left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@XhmikosR @DL6ER